package com.fast.framework.config.swagger;

import com.fast.framework.enums.JwtEnum;
import io.swagger.annotations.ApiOperation;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.*;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.service.contexts.SecurityContext;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;
import java.util.List;

/**
 * <p>
 * Swagger API文档
 * </p>
 *
 * @author lanyuankeji
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    /**
     * 创建一个 Docket 实例来配置 Swagger 文档的生成
     *
     * @return Docket 实例
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                // 设置 Swagger 文档的类型为 SWAGGER_2
                .apiInfo(apiInfo()) // 配置 API 信息
                .select()
                // 扫描所有有注解的api，用这种方式更灵活
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                // 扫描指定包中的swagger注解
                // .apis(RequestHandlerSelectors.basePackage("com.fast.project.tool.swagger"))
                // 扫描所有 .apis(RequestHandlerSelectors.any())
                // 设置要处理的路径，使用任意路径
                .paths(PathSelectors.any())
                .build() // 构建 Docket 实例
                // 配置安全上下文和安全方案
                .securityContexts(securityContexts())
                .securitySchemes(securitySchemes());
    }


    /**
     * 配置 Swagger 的安全方案列表
     *
     * @return 返回包含安全方案的列表
     */
    private List<SecurityScheme> securitySchemes() {
        // 创建一个空的安全方案列表
        List<SecurityScheme> result = new ArrayList<>();
        // 创建一个 API Key 安全方案
        ApiKey apiKey = new ApiKey(JwtEnum.tokenHeader.getValue(), JwtEnum.tokenHeader.getValue(), "Header");
        // 将 API Key 安全方案添加到安全方案列表中
        result.add(apiKey);
        // 返回包含安全方案的列表
        return result;
    }

    private List<SecurityContext> securityContexts() {
        List<SecurityContext> result = new ArrayList<>();
        result.add(getContextByPath());
        return result;
    }

    /**
     * 根据路径创建安全上下文
     *
     * @return 返回安全上下文对象
     */
    private SecurityContext getContextByPath() {
        // 使用 SecurityContext.builder() 创建 SecurityContext 对象，并设置安全参考和路径匹配规则
        return SecurityContext.builder()
                .securityReferences(defaultAuth()) // 设置安全参考
                .operationSelector(o -> o.requestMappingPattern().matches("/.*")) // 指定需要应用安全上下文的路径
                .build(); // 构建安全上下文对象并返回
    }

    /**
     * 默认的安全参考配置
     *
     * @return 返回包含默认安全参考的列表
     */
    private List<SecurityReference> defaultAuth() {
        // 创建一个空的安全参考列表
        List<SecurityReference> result = new ArrayList<>();
        // 创建一个 AuthorizationScope 对象，表示授权范围
        AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
        // 创建一个包含授权范围的数组
        AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
        authorizationScopes[0] = authorizationScope;
        // 将创建的安全参考添加到安全参考列表中
        result.add(new SecurityReference("Authorization", authorizationScopes));
        // 返回包含默认安全参考的列表
        return result;
    }


    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("澜源科技")
                .description("澜源科技")
                .contact(new Contact("xxx", "https://www.xxxxxxxxx.com", "xxxxxxx@xx.com"))
                .version("版本号:1.0")
                .build();
    }
}
